<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Welcome to wltrweb’s documentation! &mdash; wltrweb documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '#',
        VERSION:     '0',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="top" title="wltrweb documentation" href="#" />
    <link rel="next" title="Table of contents" href="contents.html" />
 
<script type="text/javascript" src="templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
    if (!django_template_builtins) {
       // templatebuiltins.js missing, do nothing.
       return;
    }
    $(document).ready(function() {
        // Hyperlink Django template tags and filters
        var base = "ref/templates/builtins.html";
        if (base == "#") {
            // Special case for builtins.html itself
            base = "";
        }
        // Tags are keywords, class '.k'
        $("div.highlight\\-html\\+django span.k").each(function(i, elem) {
             var tagname = $(elem).text();
             if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
                 var fragment = tagname.replace(/_/, '-');
                 $(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
             }
        });
        // Filters are functions, class '.nf'
        $("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
             var filtername = $(elem).text();
             if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
                 var fragment = filtername.replace(/_/, '-');
                 $(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
             }
        });
    });
})(jQuery);
</script>

  </head>
  <body>

    <div class="document">
  <div id="custom-doc" class="">
    <div id="hd">
      <h1><a href="#">wltrweb documentation</a></h1>
      <div id="global-nav">
        <a title="Home page" href="#">Home</a>  |
        <a title="Table of contents" href="contents.html">Table of contents</a>  |
        <a title="Global index" href="genindex.html">Index</a> <!-- |
        <a title="Module index" href="py-modindex.html">Modules</a> -->
      </div>
      <div class="nav">
    <a title="wltrweb documentation" href="#" accesskey="U">up</a>
   |
    <a href="contents.html" title="Table of contents">next</a> &raquo;</div>
    </div>
    
    <div id="bd">
      <div id="yui-main">
        <div class="yui-b">
          <div class="yui-g" id="index">
            
  <div class="section" id="welcome-to-wltrweb-s-documentation">
<h1>Welcome to wltrweb&#8217;s documentation!<a class="headerlink" href="#welcome-to-wltrweb-s-documentation" title="Permalink to this headline">¶</a></h1>
<p class="rubric">Everything you need to know about wltrweb.</p>
<p><strong>See also:</strong> <a class="reference external" href="contents.html"><em>Table of contents</em></a> | <a class="reference external" href="genindex.html"><em>Index</em></a> |
<a class="reference external" href="search.html"><em>Search Page</em></a> | <a class="reference external" href="faq.html"><em>FAQ</em></a> | <a class="reference external" href="license.html"><em>License</em></a> | <a class="reference external" href="changelog.html"><em>Changelog</em></a></p>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<div class="section" id="motivation">
<h3>Motivation<a class="headerlink" href="#motivation" title="Permalink to this headline">¶</a></h3>
<p>I use <em>wltrweb</em> as my repository of common Django apps and functions for web
developing. It helps me to set up a new project quickly. And since I want to
improve my english and programming skill, I want to share this library.</p>
<p>Issue reports, recommendations and patches are <strong>very welcome</strong>,
anyway.</p>
</div>
<div class="section" id="important">
<h3>Important<a class="headerlink" href="#important" title="Permalink to this headline">¶</a></h3>
<p>This library is under development yet and contains undocumented apps and
functions. Please only use modules, which are documented here and declared as
stable. Other could change any moment.</p>
</div>
<div class="section" id="the-documentation">
<h3>The documentation<a class="headerlink" href="#the-documentation" title="Permalink to this headline">¶</a></h3>
<p>My english badly needs to get improved (as you see). If you find any grammar or
spelling mistake, then please let me know it. I would appreciate it very much!</p>
<p>You find the most up to date version under:
<a class="reference external" href="http://wltrweb.googlecode.com/svn/trunk/docs/html/index.html">http://wltrweb.googlecode.com/svn/trunk/docs/html/index.html</a></p>
<p>Futhermore, every release should contain these docs.</p>
</div>
</div>
<div class="section" id="getting-started">
<h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<div class="section" id="requirements">
<h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Python 2.5 or greater (not 3.x)</li>
<li>Django 1.2 or greater</li>
</ul>
</div>
<div class="section" id="installation">
<h3>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h3>
<ol class="arabic simple">
<li>Download the latest release from <a class="reference external" href="http://code.google.com/p/wltrweb/downloads/list">http://code.google.com/p/wltrweb/downloads/list</a>.</li>
<li>Unpack archive.</li>
<li>Run <tt class="docutils literal"><span class="pre">setup.py</span> <span class="pre">install</span></tt>. Maybe you have to get root privileges (e.g. with
<tt class="docutils literal"><span class="pre">sudo</span> <span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></tt>).</li>
</ol>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You also could put the <tt class="docutils literal"><span class="pre">wltrweb</span></tt> package into your Python path any other
way you want. The package is the directory containing directories like
<tt class="docutils literal"><span class="pre">apps</span></tt> and <tt class="docutils literal"><span class="pre">utils</span></tt>.</p>
</div>
</div>
<div class="section" id="usage">
<h3>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h3>
<p>See documentation of required app or function.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last"><em>And again:</em> Better do not use modules, which are not documented.</p>
</div>
</div>
</div>
<div class="section" id="the-apps">
<h2>The apps<a class="headerlink" href="#the-apps" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre">wltrweb.apps</span></tt> package contains apps for the Django framework.</p>
<dl class="docutils">
<dt><a class="reference external" href="apps/mediamanager.html"><em>wltrweb.apps.mediamanager</em></a></dt>
<dd>This app can manage mediafiles for css/js compression and better caching.</dd>
</dl>
</div>
<div class="section" id="the-utils">
<h2>The utils<a class="headerlink" href="#the-utils" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre">wltrweb.utils</span></tt> package contains some helpful functions for the
website development with Django. The modules are grouped by topics.</p>
<p><em>No stable modules here, yet.</em></p>
</div>
<div class="section" id="the-contributions">
<h2>The contributions<a class="headerlink" href="#the-contributions" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre">wltrweb.contrib</span></tt> package contains helpful functions and classes. Unlike
the <tt class="docutils literal"><span class="pre">wltrweb.utils</span></tt> package the functions are bigger and one module contains
only one function or class.</p>
<p><em>No stable modules here, yet.</em></p>
</div>
<div class="section" id="the-hacks">
<h2>The hacks<a class="headerlink" href="#the-hacks" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre">wltrweb.hacks</span></tt> package contains a couple of hacks for the Django
framework. Use it with caution.</p>
<p><em>No stable modules here, yet.</em></p>
</div>
</div>


          </div>         
        </div>
      </div>
      
        
      
    </div>
    
    <div id="ft">
      <div class="nav">
    <a title="wltrweb documentation" href="#" accesskey="U">up</a>
   |
    <a href="contents.html" title="Table of contents">next</a> &raquo;</div>
    </div>
  </div>

      <div class="clearer"></div>
    </div>
  </body>
</html>